\rcube_message_header

Struct representing an e-mail message header

Summary

Methods
Properties
Constants
get()
set()
from_array()
$id
$uid
$subject
$from
$to
$cc
$replyto
$in_reply_to
$date
$messageID
$size
$encoding
$charset
$ctype
$timestamp
$bodystructure
$internaldate
$references
$priority
$mdn_to
$folder
$others
$flags
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$obj_headers
N/A

Properties

$id

$id : int

Message sequence number

Type

int

$uid

$uid : int

Message unique identifier

Type

int

$subject

$subject : string

Message subject

Type

string

$from

$from : string

Message sender (From)

Type

string

$to

$to : string

Message recipient (To)

Type

string

$cc

$cc : string

Message additional recipients (Cc)

Type

string

$replyto

$replyto : string

Message Reply-To header

Type

string

$in_reply_to

$in_reply_to : string

Message In-Reply-To header

Type

string

$date

$date : string

Message date (Date)

Type

string

$messageID

$messageID : string

Message identifier (Message-ID)

Type

string

$size

$size : int

Message size

Type

int

$encoding

$encoding : string

Message encoding

Type

string

$charset

$charset : string

Message charset

Type

string

$ctype

$ctype : string

Message Content-type

Type

string

$timestamp

$timestamp : int

Message timestamp (based on message date)

Type

int

$bodystructure

$bodystructure : string

IMAP bodystructure string

Type

string

$internaldate

$internaldate : string

IMAP internal date

Type

string

$references

$references : string

Message References header

Type

string

$priority

$priority : int

Message priority (X-Priority)

Type

int

$mdn_to

$mdn_to : string

Message receipt recipient

Type

string

$folder

$folder : string

IMAP folder this message is stored in

Type

string

$others

$others : array

Other message headers

Type

array

$flags

$flags : array

Message flags

Type

array

$obj_headers

$obj_headers : array

Header name to rcube_message_header object property map

Type

array

Methods

get()

get(string  $name, bool  $decode = true) : mixed

Returns header value

Parameters

string $name

Header name

bool $decode

Decode the header content

Returns

mixed —

set()

set(string  $name, string  $value) : mixed

Sets header value

Parameters

string $name

Header name

string $value

Header content

Returns

mixed —

from_array()

from_array(array  $arr) : \rcube_message_header

Factory method to instantiate headers from a data array

Parameters

array $arr

Hash array with header values

Returns

\rcube_message_header —

instance filled with headers values